Azure OpenAI API (preview:2025-01-01)

2025/02/20 • 20 new methods

ListBatches (new)
Description :  Gets a list of all batches owned by the Azure OpenAI resource.
Reference :  Link ¶

⚼ Request

GET:  /batches
{
after:
{
Description: Identifier for the last event from the previous pagination request. ,
Required: False ,
}
string ,
limit:
{
Description: Number of batches to retrieve. Defaults to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: False ,
}
[
{
id:
{
Description: The id assigned to the Batch. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `batch`. ,
Enum:
{
batch: No description available. ,
}
,
Required: True ,
}
enum ,
endpoint:
{
Description: The OpenAI API endpoint used by the batch. ,
Required: False ,
}
string ,
errors:
{
Description: The list of Batch errors. ,
Required: False ,
}
{
object:
{
Description: The object type, which is always `list`. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The list of Batch error data. ,
Required: False ,
}
[
{
code:
{
Description: An error code identifying the error type. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable message providing more details about the error. ,
Required: False ,
}
string ,
param:
{
Description: The name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
line:
{
Description: The line number of the input file where the error occurred, if applicable. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
input_file_id:
{
Description: The ID of the input file for the batch. ,
Required: True ,
}
string ,
completion_window:
{
Description: The time frame within which the batch should be processed. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the batch. ,
Enum:
{
validating: The input file is being validated before the batch can begin. ,
failed: The input file has failed the validation process. ,
in_progress: The input file was successfully validated and the batch is currently being executed. ,
finalizing: The batch has completed and the results are being prepared. ,
completed: The batch has been completed and the results are ready. ,
expired: The batch was not able to complete within the 24-hour time window. ,
cancelling: Cancellation of the batch has been initiated. ,
cancelled: The batch was cancelled. ,
}
,
Required: False ,
}
enum ,
output_file_id:
{
Description: The ID of the file containing the outputs of successfully executed requests. ,
Required: False ,
}
string ,
error_file_id:
{
Description: The ID of the file containing the outputs of requests with errors. ,
Required: False ,
}
string ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the batch was created. ,
Format: unixtime ,
Required: False ,
}
integer ,
in_progress_at:
{
Description: The Unix timestamp (in seconds) for when the batch started processing. ,
Format: unixtime ,
Required: False ,
}
integer ,
expires_at:
{
Description: The Unix timestamp (in seconds) for when the batch will expire. ,
Format: unixtime ,
Required: False ,
}
integer ,
finalizing_at:
{
Description: The Unix timestamp (in seconds) for when the batch started finalizing. ,
Format: unixtime ,
Required: False ,
}
integer ,
completed_at:
{
Description: The Unix timestamp (in seconds) for when the batch was completed. ,
Format: unixtime ,
Required: False ,
}
integer ,
failed_at:
{
Description: The Unix timestamp (in seconds) for when the batch failed. ,
Format: unixtime ,
Required: False ,
}
integer ,
expired_at:
{
Description: The Unix timestamp (in seconds) for when the batch expired. ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelling_at:
{
Description: The Unix timestamp (in seconds) for when the batch started cancelling. ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp (in seconds) for when the batch was cancelled. ,
Format: unixtime ,
Required: False ,
}
integer ,
request_counts:
{
Description: The request counts for different statuses within the batch. ,
Required: False ,
}
{
total:
{
Description: Total number of requests in the batch. ,
Format: int32 ,
Required: False ,
}
integer ,
completed:
{
Description: Number of requests that have been completed successfully. ,
Format: int32 ,
Required: False ,
}
integer ,
failed:
{
Description: Number of requests that have failed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
metadata:
{
Description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format. ,
Required: False ,
}
object ,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: False ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: False ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: False ,
}
boolean ,
}
CreateBatch (new)
Description :  Creates and executes a batch from an uploaded file of requests. Response includes details of the enqueued job including job status. The ID of the result file is added to the response once complete.
Reference :  Link ¶

⚼ Request

POST:  /batches
{
createBatchRequest:
{
Description: The specification of the batch to create and execute. ,
Required: True ,
}
{
endpoint:
{
Description: The API endpoint used by the batch. ,
Required: True ,
}
string ,
input_file_id:
{
Description: The ID of the input file for the batch. ,
Required: True ,
}
string ,
completion_window:
{
Description: The time frame within which the batch should be processed. ,
Required: True ,
}
string ,
metadata:
{
Description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The id assigned to the Batch. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `batch`. ,
Enum:
{
batch: No description available. ,
}
,
Required: True ,
}
enum ,
endpoint:
{
Description: The OpenAI API endpoint used by the batch. ,
Required: False ,
}
string ,
errors:
{
Description: The list of Batch errors. ,
Required: False ,
}
{
object:
{
Description: The object type, which is always `list`. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The list of Batch error data. ,
Required: False ,
}
[
{
code:
{
Description: An error code identifying the error type. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable message providing more details about the error. ,
Required: False ,
}
string ,
param:
{
Description: The name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
line:
{
Description: The line number of the input file where the error occurred, if applicable. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
input_file_id:
{
Description: The ID of the input file for the batch. ,
Required: True ,
}
string ,
completion_window:
{
Description: The time frame within which the batch should be processed. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the batch. ,
Enum:
{
validating: The input file is being validated before the batch can begin. ,
failed: The input file has failed the validation process. ,
in_progress: The input file was successfully validated and the batch is currently being executed. ,
finalizing: The batch has completed and the results are being prepared. ,
completed: The batch has been completed and the results are ready. ,
expired: The batch was not able to complete within the 24-hour time window. ,
cancelling: Cancellation of the batch has been initiated. ,
cancelled: The batch was cancelled. ,
}
,
Required: False ,
}
enum ,
output_file_id:
{
Description: The ID of the file containing the outputs of successfully executed requests. ,
Required: False ,
}
string ,
error_file_id:
{
Description: The ID of the file containing the outputs of requests with errors. ,
Required: False ,
}
string ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the batch was created. ,
Format: unixtime ,
Required: False ,
}
integer ,
in_progress_at:
{
Description: The Unix timestamp (in seconds) for when the batch started processing. ,
Format: unixtime ,
Required: False ,
}
integer ,
expires_at:
{
Description: The Unix timestamp (in seconds) for when the batch will expire. ,
Format: unixtime ,
Required: False ,
}
integer ,
finalizing_at:
{
Description: The Unix timestamp (in seconds) for when the batch started finalizing. ,
Format: unixtime ,
Required: False ,
}
integer ,
completed_at:
{
Description: The Unix timestamp (in seconds) for when the batch was completed. ,
Format: unixtime ,
Required: False ,
}
integer ,
failed_at:
{
Description: The Unix timestamp (in seconds) for when the batch failed. ,
Format: unixtime ,
Required: False ,
}
integer ,
expired_at:
{
Description: The Unix timestamp (in seconds) for when the batch expired. ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelling_at:
{
Description: The Unix timestamp (in seconds) for when the batch started cancelling. ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp (in seconds) for when the batch was cancelled. ,
Format: unixtime ,
Required: False ,
}
integer ,
request_counts:
{
Description: The request counts for different statuses within the batch. ,
Required: False ,
}
{
total:
{
Description: Total number of requests in the batch. ,
Format: int32 ,
Required: False ,
}
integer ,
completed:
{
Description: Number of requests that have been completed successfully. ,
Format: int32 ,
Required: False ,
}
integer ,
failed:
{
Description: Number of requests that have failed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
metadata:
{
Description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format. ,
Required: False ,
}
object ,
}
GetBatch (new)
Description :  Gets details for a single batch specified by the given batchID.
Reference :  Link ¶

⚼ Request

GET:  /batches/{batchId}
{
batchId:
{
Description: The identifier of the batch. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id assigned to the Batch. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `batch`. ,
Enum:
{
batch: No description available. ,
}
,
Required: True ,
}
enum ,
endpoint:
{
Description: The OpenAI API endpoint used by the batch. ,
Required: False ,
}
string ,
errors:
{
Description: The list of Batch errors. ,
Required: False ,
}
{
object:
{
Description: The object type, which is always `list`. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The list of Batch error data. ,
Required: False ,
}
[
{
code:
{
Description: An error code identifying the error type. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable message providing more details about the error. ,
Required: False ,
}
string ,
param:
{
Description: The name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
line:
{
Description: The line number of the input file where the error occurred, if applicable. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
input_file_id:
{
Description: The ID of the input file for the batch. ,
Required: True ,
}
string ,
completion_window:
{
Description: The time frame within which the batch should be processed. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the batch. ,
Enum:
{
validating: The input file is being validated before the batch can begin. ,
failed: The input file has failed the validation process. ,
in_progress: The input file was successfully validated and the batch is currently being executed. ,
finalizing: The batch has completed and the results are being prepared. ,
completed: The batch has been completed and the results are ready. ,
expired: The batch was not able to complete within the 24-hour time window. ,
cancelling: Cancellation of the batch has been initiated. ,
cancelled: The batch was cancelled. ,
}
,
Required: False ,
}
enum ,
output_file_id:
{
Description: The ID of the file containing the outputs of successfully executed requests. ,
Required: False ,
}
string ,
error_file_id:
{
Description: The ID of the file containing the outputs of requests with errors. ,
Required: False ,
}
string ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the batch was created. ,
Format: unixtime ,
Required: False ,
}
integer ,
in_progress_at:
{
Description: The Unix timestamp (in seconds) for when the batch started processing. ,
Format: unixtime ,
Required: False ,
}
integer ,
expires_at:
{
Description: The Unix timestamp (in seconds) for when the batch will expire. ,
Format: unixtime ,
Required: False ,
}
integer ,
finalizing_at:
{
Description: The Unix timestamp (in seconds) for when the batch started finalizing. ,
Format: unixtime ,
Required: False ,
}
integer ,
completed_at:
{
Description: The Unix timestamp (in seconds) for when the batch was completed. ,
Format: unixtime ,
Required: False ,
}
integer ,
failed_at:
{
Description: The Unix timestamp (in seconds) for when the batch failed. ,
Format: unixtime ,
Required: False ,
}
integer ,
expired_at:
{
Description: The Unix timestamp (in seconds) for when the batch expired. ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelling_at:
{
Description: The Unix timestamp (in seconds) for when the batch started cancelling. ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp (in seconds) for when the batch was cancelled. ,
Format: unixtime ,
Required: False ,
}
integer ,
request_counts:
{
Description: The request counts for different statuses within the batch. ,
Required: False ,
}
{
total:
{
Description: Total number of requests in the batch. ,
Format: int32 ,
Required: False ,
}
integer ,
completed:
{
Description: Number of requests that have been completed successfully. ,
Format: int32 ,
Required: False ,
}
integer ,
failed:
{
Description: Number of requests that have failed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
metadata:
{
Description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format. ,
Required: False ,
}
object ,
}
CancelBatch (new)
Description :  Gets details for a single batch specified by the given batchID.
Reference :  Link ¶

⚼ Request

POST:  /batches/{batchId}/cancel
{
batchId:
{
Description: The identifier of the batch. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id assigned to the Batch. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `batch`. ,
Enum:
{
batch: No description available. ,
}
,
Required: True ,
}
enum ,
endpoint:
{
Description: The OpenAI API endpoint used by the batch. ,
Required: False ,
}
string ,
errors:
{
Description: The list of Batch errors. ,
Required: False ,
}
{
object:
{
Description: The object type, which is always `list`. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The list of Batch error data. ,
Required: False ,
}
[
{
code:
{
Description: An error code identifying the error type. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable message providing more details about the error. ,
Required: False ,
}
string ,
param:
{
Description: The name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
line:
{
Description: The line number of the input file where the error occurred, if applicable. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
input_file_id:
{
Description: The ID of the input file for the batch. ,
Required: True ,
}
string ,
completion_window:
{
Description: The time frame within which the batch should be processed. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the batch. ,
Enum:
{
validating: The input file is being validated before the batch can begin. ,
failed: The input file has failed the validation process. ,
in_progress: The input file was successfully validated and the batch is currently being executed. ,
finalizing: The batch has completed and the results are being prepared. ,
completed: The batch has been completed and the results are ready. ,
expired: The batch was not able to complete within the 24-hour time window. ,
cancelling: Cancellation of the batch has been initiated. ,
cancelled: The batch was cancelled. ,
}
,
Required: False ,
}
enum ,
output_file_id:
{
Description: The ID of the file containing the outputs of successfully executed requests. ,
Required: False ,
}
string ,
error_file_id:
{
Description: The ID of the file containing the outputs of requests with errors. ,
Required: False ,
}
string ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the batch was created. ,
Format: unixtime ,
Required: False ,
}
integer ,
in_progress_at:
{
Description: The Unix timestamp (in seconds) for when the batch started processing. ,
Format: unixtime ,
Required: False ,
}
integer ,
expires_at:
{
Description: The Unix timestamp (in seconds) for when the batch will expire. ,
Format: unixtime ,
Required: False ,
}
integer ,
finalizing_at:
{
Description: The Unix timestamp (in seconds) for when the batch started finalizing. ,
Format: unixtime ,
Required: False ,
}
integer ,
completed_at:
{
Description: The Unix timestamp (in seconds) for when the batch was completed. ,
Format: unixtime ,
Required: False ,
}
integer ,
failed_at:
{
Description: The Unix timestamp (in seconds) for when the batch failed. ,
Format: unixtime ,
Required: False ,
}
integer ,
expired_at:
{
Description: The Unix timestamp (in seconds) for when the batch expired. ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelling_at:
{
Description: The Unix timestamp (in seconds) for when the batch started cancelling. ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp (in seconds) for when the batch was cancelled. ,
Format: unixtime ,
Required: False ,
}
integer ,
request_counts:
{
Description: The request counts for different statuses within the batch. ,
Required: False ,
}
{
total:
{
Description: Total number of requests in the batch. ,
Format: int32 ,
Required: False ,
}
integer ,
completed:
{
Description: Number of requests that have been completed successfully. ,
Format: int32 ,
Required: False ,
}
integer ,
failed:
{
Description: Number of requests that have failed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
metadata:
{
Description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format. ,
Required: False ,
}
object ,
}
GenerateSpeechFromText (new)
Description :  Generates text-to-speech audio from the input text.
Reference :  Link ¶

⚼ Request

POST:  /deployments/{deploymentId}/audio/speech
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentId:
{
Description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. ,
Required: True ,
}
string ,
body:
{
Description: A representation of the request options that control the behavior of a text-to-speech operation. ,
Required: True ,
}
{
input:
{
Description: The text to generate audio for. The maximum length is 4096 characters. ,
Required: True ,
}
string ,
voice:
{
Description: The voice to use for text-to-speech. ,
Enum:
{
alloy: The Alloy voice. ,
echo: The Echo voice. ,
fable: The Fable voice. ,
onyx: The Onyx voice. ,
nova: The Nova voice. ,
shimmer: The Shimmer voice. ,
}
,
Required: True ,
}
enum ,
response_format:
{
Description: The audio output format for the spoken text. By default, the MP3 format will be used. ,
Enum:
{
mp3: Use MP3 as the audio output format. MP3 is the default, general-purpose format. ,
opus: Use Opus as the audio output format. Opus is optimized for internet streaming and low latency. ,
aac: Use AAC as the audio output format. AAC is optimized for digital audio compression and is preferred by YouTube, Android, and iOS. ,
flac: Use FLAC as the audio output format. FLAC is a fully lossless format optimized for maximum quality at the expense of size. ,
wav: Use uncompressed WAV as the audio output format, suitable for low-latency applications to avoid decoding overhead. ,
pcm: Use uncompressed PCM as the audio output format, which is similar to WAV but contains raw samples in 24kHz (16-bit signed, low-endian), without the header. ,
}
,
Required: False ,
}
enum ,
speed:
{
Description: The speed of speech for generated audio. Values are valid in the range from 0.25 to 4.0, with 1.0 the default and higher values corresponding to faster speech. ,
Format: float ,
Required: False ,
}
number ,
model:
{
Description: The model to use for this text-to-speech request. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetAudioTranscriptionAsPlainText (new)
Description :  Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the written language corresponding to the language it was spoken in.
Reference :  Link ¶

⚼ Request

POST:  /deployments/{deploymentId}/audio/transcriptions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentId:
{
Description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. ,
Required: True ,
}
string ,
file:
{
Description: The audio data to transcribe. This must be the binary content of a file in one of the supported media formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm. ,
Required: True ,
}
file ,
filename:
{
Description: The optional filename or descriptive identifier to associate with with the audio data. ,
Required: False ,
}
string ,
response_format:
{
Description: The requested format of the transcription response data, which will influence the content and detail of the result. ,
Required: False ,
}
string ,
language:
{
Description: The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code such as 'en' or 'fr'. Providing this known input language is optional but may improve the accuracy and/or latency of transcription. ,
Required: False ,
}
string ,
prompt:
{
Description: An optional hint to guide the model's style or continue from a prior audio segment. The written language of the prompt should match the primary spoken language of the audio data. ,
Required: False ,
}
string ,
temperature:
{
Description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. ,
Format: float ,
Required: False ,
}
number ,
timestamp_granularities:
{
Description: The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency. ,
Required: False ,
}
array ,
model:
{
Description: The model to use for this transcription request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetAudioTranslationAsPlainText (new)
Description :  Gets English language transcribed text and associated metadata from provided spoken audio data.
Reference :  Link ¶

⚼ Request

POST:  /deployments/{deploymentId}/audio/translations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentId:
{
Description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. ,
Required: True ,
}
string ,
file:
{
Description: The audio data to translate. This must be the binary content of a file in one of the supported media formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm. ,
Required: True ,
}
file ,
filename:
{
Description: The optional filename or descriptive identifier to associate with with the audio data. ,
Required: False ,
}
string ,
response_format:
{
Description: The requested format of the translation response data, which will influence the content and detail of the result. ,
Required: False ,
}
string ,
prompt:
{
Description: An optional hint to guide the model's style or continue from a prior audio segment. The written language of the prompt should match the primary spoken language of the audio data. ,
Required: False ,
}
string ,
temperature:
{
Description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. ,
Format: float ,
Required: False ,
}
number ,
model:
{
Description: The model to use for this translation request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetChatCompletions (new)
Description :  Gets chat completions for the provided chat messages. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
Reference :  Link ¶

⚼ Request

POST:  /deployments/{deploymentId}/chat/completions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentId:
{
Description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. ,
Required: True ,
}
string ,
body:
{
Description: The configuration information for a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data. ,
Required: True ,
}
{
messages:
{
Description: The collection of context messages associated with this chat completions request. Typical usage begins with a chat message for the System role that provides instructions for the behavior of the assistant, followed by alternating messages between the User and Assistant roles. ,
Required: True ,
}
[
{
role:
{
Description: The chat role associated with this message. ,
Enum:
{
system: The role that instructs or sets the behavior of the assistant. ,
assistant: The role that provides responses to system-instructed, user-prompted input. ,
user: The role that provides input for chat completions. ,
function: The role that provides function results for chat completions. ,
tool: The role that represents extension tool activity within a chat completions operation. ,
developer: The role that provides instructions that the model should follow ,
}
,
Required: True ,
}
enum ,
}
,
]
,
functions:
{
Description: A list of functions the model may generate JSON inputs for. ,
Required: False ,
}
[
{
name:
{
Description: The name of the function to be called. ,
Required: True ,
}
string ,
description:
{
Description: A description of what the function does. The model will use this description when selecting the function and interpreting its parameters. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters the function accepts, described as a JSON Schema object. ,
Required: False ,
}
string ,
}
,
]
,
function_call:
{
Description: Controls how the model responds to function calls. "none" means the model does not call a function, and responds to the end-user. "auto" means the model can pick between an end-user or calling a function. Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. "none" is the default when no functions are present. "auto" is the default if functions are present. ,
Required: False ,
}
string ,
max_tokens:
{
Description: The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with o1 series models. ,
Format: int32 ,
Required: False ,
}
integer ,
max_completion_tokens:
{
Description: An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. ,
Format: int32 ,
Required: False ,
}
integer ,
temperature:
{
Description: The sampling temperature to use that controls the apparent creativity of generated completions. Higher values will make output more random while lower values will make results more focused and deterministic. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: An alternative to sampling with temperature called nucleus sampling. This value causes the model to consider the results of tokens with the provided probability mass. As an example, a value of 0.15 will cause only the tokens comprising the top 15% of probability mass to be considered. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. ,
Format: float ,
Required: False ,
}
number ,
logit_bias:
{
Description: A map between GPT token IDs and bias scores that influences the probability of specific tokens appearing in a completions response. Token IDs are computed via external tokenizer tools, while bias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to a full ban or exclusive selection of a token, respectively. The exact behavior of a given bias score varies by model. ,
Required: False ,
}
object ,
user:
{
Description: An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes. ,
Required: False ,
}
string ,
n:
{
Description: The number of chat completions choices that should be generated for a chat completions response. Because this setting can generate many completions, it may quickly consume your token quota. Use carefully and ensure reasonable settings for max_tokens and stop. ,
Format: int32 ,
Required: False ,
}
integer ,
stop:
{
Description: A collection of textual sequences that will end completions generation. ,
Required: False ,
}
[
string ,
]
,
presence_penalty:
{
Description: A value that influences the probability of generated tokens appearing based on their existing presence in generated text. Positive values will make tokens less likely to appear when they already exist and increase the model's likelihood to output new topics. ,
Format: float ,
Required: False ,
}
number ,
frequency_penalty:
{
Description: A value that influences the probability of generated tokens appearing based on their cumulative frequency in generated text. Positive values will make tokens less likely to appear as their frequency increases and decrease the likelihood of the model repeating the same statements verbatim. ,
Format: float ,
Required: False ,
}
number ,
stream:
{
Description: A value indicating whether chat completions should be streamed for this request. ,
Required: False ,
}
boolean ,
stream_options:
{
Description: Options for streaming response. Only set this when you set `stream: true`. ,
Required: False ,
}
object ,
model:
{
Description: The model name to provide as part of this completions request. Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that's connected to. ,
Required: False ,
}
string ,
data_sources:
{
Description: The configuration entries for Azure OpenAI chat extensions that use them. This additional specification is only compatible with Azure OpenAI. ,
Required: False ,
}
[
{
type:
{
Description: The label for the type of an Azure chat extension. This typically corresponds to a matching Azure resource. Azure chat extensions are only compatible with Azure OpenAI. ,
Enum:
{
azure_search: Represents the use of Azure AI Search as an Azure OpenAI chat extension. ,
azure_cosmos_db: Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension. ,
elasticsearch: Represents the use of Elasticsearch® index as an Azure OpenAI chat extension. ,
pinecone: Represents the use of Pinecone index as an Azure OpenAI chat extension. ,
mongo_db: Represents the use of a MongoDB chat extension. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
enhancements:
{
Description: If provided, the configuration options for available Azure OpenAI chat enhancements. ,
Required: False ,
}
{
grounding:
{
Description: A representation of the available options for the Azure OpenAI grounding enhancement. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether the enhancement is enabled. ,
Required: True ,
}
boolean ,
}
,
ocr:
{
Description: A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether the enhancement is enabled. ,
Required: True ,
}
boolean ,
}
,
}
,
seed:
{
Description: If specified, the system will make a best effort to sample deterministically such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend." ,
Format: int64 ,
Required: False ,
}
integer ,
logprobs:
{
Description: Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. This option is currently not available on the `gpt-4-vision-preview` model. ,
Required: False ,
}
boolean ,
top_logprobs:
{
Description: An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. ,
Format: int32 ,
Required: False ,
}
integer ,
response_format:
{
Description: An object specifying the format that the model must output. Used to enable JSON mode. ,
Required: False ,
}
{
type:
{
Description: The discriminated type for the response format. ,
Required: True ,
}
string ,
}
,
tools:
{
Description: The available tool definitions that the chat completions request can use, including caller-defined functions. ,
Required: False ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_choice:
{
Description: If specified, the model will configure which of the provided tools it can use for the chat completions response. ,
Required: False ,
}
string ,
parallel_tool_calls:
{
Description: Whether to enable parallel function calling during tool use. ,
Required: False ,
}
boolean ,
store:
{
Description: Whether or not to store the output of this chat completion request for use in our model distillation or evaluation products. ,
Required: False ,
}
boolean ,
metadata:
{
Description: Developer-defined tags and values used for filtering completions in the stored completions dashboard. ,
Required: False ,
}
object ,
reasoning_effort:
{
Description: This option is only valid for o1 models, Constrains effort on reasoning for reasoning models (see https://platform.openai.com/docs/guides/reasoning). Currently supported values are `low`, `medium`, and `high`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. ,
Enum:
{
low: The reasoning effort is low. ,
medium: The reasoning effort is medium. ,
high: The reasoning effort is high. ,
}
,
Required: False ,
}
enum ,
user_security_context:
{
Description: The security context identifies and authenticates users and applications in your multi-tenant AI system, helping security teams investigate and mitigate incidents. ,
Required: False ,
}
{
application_name:
{
Description: The name of the application. Sensitive personal information should not be included in this field. ,
Required: False ,
}
string ,
end_user_id:
{
Description: This identifier is the Microsoft Entra ID (formerly Azure Active Directory) user object ID used to authenticate end-users within the generative AI application. Sensitive personal information should not be included in this field. ,
Format: uuid ,
Required: False ,
}
string ,
end_user_tenant_id:
{
Description: The Microsoft 365 tenant ID the end user belongs to. It's required when the generative AI application is multi tenant. ,
Format: uuid ,
Required: False ,
}
string ,
source_ip:
{
Description: Captures the original client's IP address, accepting both IPv4 and IPv6 formats. ,
Required: False ,
}
string ,
}
,
modalities:
{
Description: Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default: `["text"]` The `gpt-4o-audio-preview` model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: `["text", "audio"]` ,
Required: False ,
}
[
string ,
]
,
prediction:
{
Description: Configuration for a Predicted Output, which can greatly improve response times when large parts of the model response are known ahead of time. This is most common when you are regenerating a file with only minor changes to most of the content. ,
Required: False ,
}
{
type:
{
Description: The type of the predicted content you want to provide. This type is currently always `content`. ,
Enum:
{
content: No description available. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The content that should be matched when generating a model response. If generated tokens would match this content, the entire model response can be returned much more quickly. ,
Required: True ,
}
string ,
}
,
audio:
{
Description: Parameters for audio output. Required when audio output is requested with `modalities: ["audio"]` ,
Required: False ,
}
{
voice:
{
Description: Specifies the voice type. ,
Enum:
{
alloy: The Alloy voice. ,
echo: The Echo voice. ,
fable: The Fable voice. ,
onyx: The Onyx voice. ,
nova: The Nova voice. ,
shimmer: The Shimmer voice. ,
}
,
Required: True ,
}
enum ,
format:
{
Description: Specifies the output audio format. ,
Enum:
{
wav: The output audio format is WAV. ,
mp3: The output audio format is MP3. ,
flac: The output audio format is FLAC. ,
opus: The output audio format is OPUS. ,
pcm16: The output audio format is PCM16. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: A unique identifier associated with this chat completions response. ,
Required: True ,
}
string ,
created:
{
Description: The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970. ,
Format: unixtime ,
Required: True ,
}
integer ,
choices:
{
Description: The collection of completions choices associated with this completions response. Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated. ,
Required: True ,
}
[
{
message:
{
Description: The chat message for a given chat completions prompt. ,
Required: False ,
}
{
role:
{
Description: The chat role associated with the message. ,
Enum:
{
system: The role that instructs or sets the behavior of the assistant. ,
assistant: The role that provides responses to system-instructed, user-prompted input. ,
user: The role that provides input for chat completions. ,
function: The role that provides function results for chat completions. ,
tool: The role that represents extension tool activity within a chat completions operation. ,
developer: The role that provides instructions that the model should follow ,
}
,
Required: True ,
}
enum ,
refusal:
{
Description: The refusal message generated by the model. ,
Required: True ,
}
string ,
content:
{
Description: The content of the message. ,
Required: True ,
}
string ,
tool_calls:
{
Description: The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat completions request to resolve as configured. ,
Required: False ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
id:
{
Description: The ID of the tool call. ,
Required: True ,
}
string ,
}
,
]
,
function_call:
{
Description: The function call that must be resolved and have its output appended to subsequent input messages for the chat completions request to resolve as configured. ,
Required: False ,
}
{
name:
{
Description: The name of the function to call. ,
Required: True ,
}
string ,
arguments:
{
Description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. ,
Required: True ,
}
string ,
}
,
audio:
{
Description: If the audio output modality is requested, this object contains data about the audio response from the model. ,
Required: False ,
}
{
id:
{
Description: Unique identifier for this audio response. ,
Required: True ,
}
string ,
expires_at:
{
Description: The Unix timestamp (in seconds) for when this audio response will no longer be accessible on the server for use in multi-turn conversations. ,
Format: unixtime ,
Required: True ,
}
integer ,
data:
{
Description: Base64 encoded audio bytes generated by the model, in the format specified in the request. ,
Required: True ,
}
string ,
transcript:
{
Description: Transcript of the audio generated by the model. ,
Required: True ,
}
string ,
}
,
context:
{
Description: If Azure OpenAI chat extensions are configured, this array represents the incremental steps performed by those extensions while processing the chat completions request. ,
Required: False ,
}
{
citations:
{
Description: The contextual information associated with the Azure chat extensions used for a chat completions request. These messages describe the data source retrievals, plugin invocations, and other intermediate steps taken in the course of generating a chat completions response that was augmented by capabilities from Azure OpenAI chat extensions. ,
Required: False ,
}
[
{
content:
{
Description: The content of the citation. ,
Required: True ,
}
string ,
title:
{
Description: The title of the citation. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the citation. ,
Required: False ,
}
string ,
filepath:
{
Description: The file path of the citation. ,
Required: False ,
}
string ,
chunk_id:
{
Description: The chunk ID of the citation. ,
Required: False ,
}
string ,
rerank_score:
{
Description: The rerank score of the retrieved document. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
intent:
{
Description: The detected intent from the chat history, used to pass to the next turn to carry over the context. ,
Required: False ,
}
string ,
all_retrieved_documents:
{
Description: All the retrieved documents. ,
Required: False ,
}
[
{
content:
{
Description: The content of the citation. ,
Required: True ,
}
string ,
title:
{
Description: The title of the citation. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the citation. ,
Required: False ,
}
string ,
filepath:
{
Description: The file path of the citation. ,
Required: False ,
}
string ,
chunk_id:
{
Description: The chunk ID of the citation. ,
Required: False ,
}
string ,
rerank_score:
{
Description: The rerank score of the retrieved document. ,
Format: double ,
Required: False ,
}
number ,
search_queries:
{
Description: The search queries used to retrieve the document. ,
Required: True ,
}
[
string ,
]
,
data_source_index:
{
Description: The index of the data source. ,
Format: int32 ,
Required: True ,
}
integer ,
original_search_score:
{
Description: The original search score of the retrieved document. ,
Format: double ,
Required: False ,
}
number ,
filter_reason:
{
Description: Represents the rationale for filtering the document. If the document does not undergo filtering, this field will remain unset. ,
Enum:
{
score: The document is filtered by original search score threshold defined by `strictness` configure. ,
rerank: The document is not filtered by original search score threshold, but is filtered by rerank score and `top_n_documents` configure. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
logprobs:
{
Description: The log probability information for this choice, as enabled via the 'logprobs' request option. ,
Required: True ,
}
object ,
index:
{
Description: The ordered index associated with this chat completions choice. ,
Format: int32 ,
Required: True ,
}
integer ,
finish_reason:
{
Description: The reason that this chat completions choice completed its generated. ,
Enum:
{
stop: Completions ended normally and reached its end of token generation. ,
length: Completions exhausted available token limits before generation could complete. ,
content_filter: Completions generated a response that was identified as potentially sensitive per content moderation policies. ,
function_call: Completion ended normally, with the model requesting a function to be called. ,
tool_calls: Completion ended with the model calling a provided tool for output. ,
}
,
Required: True ,
}
enum ,
delta:
{
Description: The delta message content for a streaming response. ,
Required: False ,
}
{
role:
{
Description: The chat role associated with the message. ,
Enum:
{
system: The role that instructs or sets the behavior of the assistant. ,
assistant: The role that provides responses to system-instructed, user-prompted input. ,
user: The role that provides input for chat completions. ,
function: The role that provides function results for chat completions. ,
tool: The role that represents extension tool activity within a chat completions operation. ,
developer: The role that provides instructions that the model should follow ,
}
,
Required: True ,
}
enum ,
refusal:
{
Description: The refusal message generated by the model. ,
Required: True ,
}
string ,
content:
{
Description: The content of the message. ,
Required: True ,
}
string ,
tool_calls:
{
Description: The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat completions request to resolve as configured. ,
Required: False ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
id:
{
Description: The ID of the tool call. ,
Required: True ,
}
string ,
}
,
]
,
function_call:
{
Description: The function call that must be resolved and have its output appended to subsequent input messages for the chat completions request to resolve as configured. ,
Required: False ,
}
{
name:
{
Description: The name of the function to call. ,
Required: True ,
}
string ,
arguments:
{
Description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. ,
Required: True ,
}
string ,
}
,
audio:
{
Description: If the audio output modality is requested, this object contains data about the audio response from the model. ,
Required: False ,
}
{
id:
{
Description: Unique identifier for this audio response. ,
Required: True ,
}
string ,
expires_at:
{
Description: The Unix timestamp (in seconds) for when this audio response will no longer be accessible on the server for use in multi-turn conversations. ,
Format: unixtime ,
Required: True ,
}
integer ,
data:
{
Description: Base64 encoded audio bytes generated by the model, in the format specified in the request. ,
Required: True ,
}
string ,
transcript:
{
Description: Transcript of the audio generated by the model. ,
Required: True ,
}
string ,
}
,
context:
{
Description: If Azure OpenAI chat extensions are configured, this array represents the incremental steps performed by those extensions while processing the chat completions request. ,
Required: False ,
}
{
citations:
{
Description: The contextual information associated with the Azure chat extensions used for a chat completions request. These messages describe the data source retrievals, plugin invocations, and other intermediate steps taken in the course of generating a chat completions response that was augmented by capabilities from Azure OpenAI chat extensions. ,
Required: False ,
}
[
{
content:
{
Description: The content of the citation. ,
Required: True ,
}
string ,
title:
{
Description: The title of the citation. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the citation. ,
Required: False ,
}
string ,
filepath:
{
Description: The file path of the citation. ,
Required: False ,
}
string ,
chunk_id:
{
Description: The chunk ID of the citation. ,
Required: False ,
}
string ,
rerank_score:
{
Description: The rerank score of the retrieved document. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
intent:
{
Description: The detected intent from the chat history, used to pass to the next turn to carry over the context. ,
Required: False ,
}
string ,
all_retrieved_documents:
{
Description: All the retrieved documents. ,
Required: False ,
}
[
{
content:
{
Description: The content of the citation. ,
Required: True ,
}
string ,
title:
{
Description: The title of the citation. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the citation. ,
Required: False ,
}
string ,
filepath:
{
Description: The file path of the citation. ,
Required: False ,
}
string ,
chunk_id:
{
Description: The chunk ID of the citation. ,
Required: False ,
}
string ,
rerank_score:
{
Description: The rerank score of the retrieved document. ,
Format: double ,
Required: False ,
}
number ,
search_queries:
{
Description: The search queries used to retrieve the document. ,
Required: True ,
}
[
string ,
]
,
data_source_index:
{
Description: The index of the data source. ,
Format: int32 ,
Required: True ,
}
integer ,
original_search_score:
{
Description: The original search score of the retrieved document. ,
Format: double ,
Required: False ,
}
number ,
filter_reason:
{
Description: Represents the rationale for filtering the document. If the document does not undergo filtering, this field will remain unset. ,
Enum:
{
score: The document is filtered by original search score threshold defined by `strictness` configure. ,
rerank: The document is not filtered by original search score threshold, but is filtered by rerank score and `top_n_documents` configure. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
content_filter_results:
{
Description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. ,
Required: False ,
}
{
sexual:
{
Description: Describes language related to anatomical organs and genitals, romantic relationships, acts portrayed in erotic or affectionate terms, physical sexual acts, including those portrayed as an assault or a forced sexual violent act against one’s will, prostitution, pornography, and abuse. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
violence:
{
Description: Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
hate:
{
Description: Describes language attacks or uses that include pejorative or discriminatory language with reference to a person or identity group on the basis of certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
self_harm:
{
Description: Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
profanity:
{
Description: Describes whether profanity was detected. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
}
,
custom_blocklists:
{
Description: Describes detection results against configured custom blocklists. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
details:
{
Description: The collection of detailed blocklist result information. ,
Required: True ,
}
[
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
id:
{
Description: The ID of the custom blocklist evaluated. ,
Required: True ,
}
string ,
}
,
]
,
}
,
error:
{
Description: Describes an error returned if the content filtering system is down or otherwise unable to complete the operation in time. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
protected_material_text:
{
Description: Information about detection of protected text material. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
}
,
protected_material_code:
{
Description: Information about detection of protected code material. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
URL:
{
Description: The internet location associated with the detection. ,
Format: uri ,
Required: False ,
}
string ,
license:
{
Description: The license description associated with the detection. ,
Required: False ,
}
string ,
}
,
ungrounded_material:
{
Description: Information about detection of ungrounded material. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
details:
{
Description: The collection of completion text spans. ,
Required: True ,
}
[
{
completion_start_offset:
{
Description: Offset of the UTF32 code point which begins the span. ,
Format: int32 ,
Required: True ,
}
integer ,
completion_end_offset:
{
Description: Offset of the first UTF32 code point which is excluded from the span. This field is always equal to completion_start_offset for empty spans. This field is always larger than completion_start_offset for non-empty spans. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
enhancements:
{
Description: Represents the output results of Azure OpenAI enhancements to chat completions, as configured via the matching input provided in the request. This supplementary information is only available when using Azure OpenAI and only when the request is configured to use enhancements. ,
Required: False ,
}
{
grounding:
{
Description: The grounding enhancement that returns the bounding box of the objects detected in the image. ,
Required: False ,
}
{
lines:
{
Description: The lines of text detected by the grounding enhancement. ,
Required: True ,
}
[
{
text:
{
Description: The text within the line. ,
Required: True ,
}
string ,
spans:
{
Description: An array of spans that represent detected objects and its bounding box information. ,
Required: True ,
}
[
{
text:
{
Description: The text content of the span that represents the detected object. ,
Required: True ,
}
string ,
offset:
{
Description: The character offset within the text where the span begins. This offset is defined as the position of the first character of the span, counting from the start of the text as Unicode codepoints. ,
Format: int32 ,
Required: True ,
}
integer ,
length:
{
Description: The length of the span in characters, measured in Unicode codepoints. ,
Format: int32 ,
Required: True ,
}
integer ,
polygon:
{
Description: An array of objects representing points in the polygon that encloses the detected object. ,
Required: True ,
}
[
{
x:
{
Description: The x-coordinate (horizontal axis) of the point. ,
Format: float ,
Required: True ,
}
number ,
y:
{
Description: The y-coordinate (vertical axis) of the point. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
model:
{
Description: The model name used for this completions request. ,
Required: False ,
}
string ,
prompt_filter_results:
{
Description: Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders. ,
Required: False ,
}
[
{
prompt_index:
{
Description: The index of this prompt in the set of prompt results ,
Format: int32 ,
Required: True ,
}
integer ,
content_filter_results:
{
Description: Content filtering results for this prompt ,
Required: True ,
}
{
sexual:
{
Description: Describes language related to anatomical organs and genitals, romantic relationships, acts portrayed in erotic or affectionate terms, physical sexual acts, including those portrayed as an assault or a forced sexual violent act against one’s will, prostitution, pornography, and abuse. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
violence:
{
Description: Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
hate:
{
Description: Describes language attacks or uses that include pejorative or discriminatory language with reference to a person or identity group on the basis of certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
self_harm:
{
Description: Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
profanity:
{
Description: Describes whether profanity was detected. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
}
,
custom_blocklists:
{
Description: Describes detection results against configured custom blocklists. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
details:
{
Description: The collection of detailed blocklist result information. ,
Required: True ,
}
[
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
id:
{
Description: The ID of the custom blocklist evaluated. ,
Required: True ,
}
string ,
}
,
]
,
}
,
error:
{
Description: Describes an error returned if the content filtering system is down or otherwise unable to complete the operation in time. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
jailbreak:
{
Description: Whether a jailbreak attempt was detected in the prompt. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
}
,
indirect_attack:
{
Description: Whether an indirect attack was detected in the prompt. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
]
,
system_fingerprint:
{
Description: Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. ,
Required: False ,
}
string ,
usage:
{
Description: Usage information for tokens processed and generated as part of this completions operation. ,
Required: True ,
}
{
completion_tokens:
{
Description: The number of tokens generated across all completions emissions. ,
Format: int32 ,
Required: True ,
}
integer ,
prompt_tokens:
{
Description: The number of tokens in the provided prompts for the completions request. ,
Format: int32 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: The total number of tokens processed for the completions request and response. ,
Format: int32 ,
Required: True ,
}
integer ,
prompt_tokens_details:
{
Description: Details of the prompt tokens. ,
Required: False ,
}
{
audio_tokens:
{
Description: Audio input tokens present in the prompt. ,
Format: int32 ,
Required: False ,
}
integer ,
cached_tokens:
{
Description: Cached tokens present in the prompt. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
completion_tokens_details:
{
Description: Breakdown of tokens used in a completion. ,
Required: False ,
}
{
accepted_prediction_tokens:
{
Description: When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion. ,
Format: int32 ,
Required: False ,
}
integer ,
audio_tokens:
{
Description: Audio input tokens generated by the model. ,
Format: int32 ,
Required: False ,
}
integer ,
reasoning_tokens:
{
Description: Tokens generated by the model for reasoning. ,
Format: int32 ,
Required: False ,
}
integer ,
rejected_prediction_tokens:
{
Description: When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetCompletions (new)
Description :  Gets completions for the provided input prompts. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
Reference :  Link ¶

⚼ Request

POST:  /deployments/{deploymentId}/completions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentId:
{
Description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. ,
Required: True ,
}
string ,
body:
{
Description: The configuration information for a completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data. ,
Required: True ,
}
{
prompt:
{
Description: The prompts to generate completions from. ,
Required: True ,
}
[
string ,
]
,
max_tokens:
{
Description: The maximum number of tokens to generate. ,
Format: int32 ,
Required: False ,
}
integer ,
temperature:
{
Description: The sampling temperature to use that controls the apparent creativity of generated completions. Higher values will make output more random while lower values will make results more focused and deterministic. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: An alternative to sampling with temperature called nucleus sampling. This value causes the model to consider the results of tokens with the provided probability mass. As an example, a value of 0.15 will cause only the tokens comprising the top 15% of probability mass to be considered. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. ,
Format: float ,
Required: False ,
}
number ,
logit_bias:
{
Description: A map between GPT token IDs and bias scores that influences the probability of specific tokens appearing in a completions response. Token IDs are computed via external tokenizer tools, while bias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to a full ban or exclusive selection of a token, respectively. The exact behavior of a given bias score varies by model. ,
Required: False ,
}
object ,
user:
{
Description: An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes. ,
Required: False ,
}
string ,
n:
{
Description: The number of completions choices that should be generated per provided prompt as part of an overall completions response. Because this setting can generate many completions, it may quickly consume your token quota. Use carefully and ensure reasonable settings for max_tokens and stop. ,
Format: int32 ,
Required: False ,
}
integer ,
logprobs:
{
Description: A value that controls the emission of log probabilities for the provided number of most likely tokens within a completions response. ,
Format: int32 ,
Required: False ,
}
integer ,
suffix:
{
Description: The suffix that comes after a completion of inserted text ,
Required: False ,
}
string ,
echo:
{
Description: A value specifying whether completions responses should include input prompts as prefixes to their generated output. ,
Required: False ,
}
boolean ,
stop:
{
Description: A collection of textual sequences that will end completions generation. ,
Required: False ,
}
[
string ,
]
,
presence_penalty:
{
Description: A value that influences the probability of generated tokens appearing based on their existing presence in generated text. Positive values will make tokens less likely to appear when they already exist and increase the model's likelihood to output new topics. ,
Format: float ,
Required: False ,
}
number ,
frequency_penalty:
{
Description: A value that influences the probability of generated tokens appearing based on their cumulative frequency in generated text. Positive values will make tokens less likely to appear as their frequency increases and decrease the likelihood of the model repeating the same statements verbatim. ,
Format: float ,
Required: False ,
}
number ,
best_of:
{
Description: A value that controls how many completions will be internally generated prior to response formulation. When used together with n, best_of controls the number of candidate completions and must be greater than n. Because this setting can generate many completions, it may quickly consume your token quota. Use carefully and ensure reasonable settings for max_tokens and stop. ,
Format: int32 ,
Required: False ,
}
integer ,
stream:
{
Description: A value indicating whether chat completions should be streamed for this request. ,
Required: False ,
}
boolean ,
stream_options:
{
Description: Options for streaming response. Only set this when you set `stream: true`. ,
Required: False ,
}
object ,
model:
{
Description: The model name to provide as part of this completions request. Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that's connected to. ,
Required: False ,
}
string ,
seed:
{
Description: If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
id:
{
Description: A unique identifier associated with this completions response. ,
Required: True ,
}
string ,
created:
{
Description: The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970. ,
Format: unixtime ,
Required: True ,
}
integer ,
prompt_filter_results:
{
Description: Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders. ,
Required: False ,
}
[
{
prompt_index:
{
Description: The index of this prompt in the set of prompt results ,
Format: int32 ,
Required: True ,
}
integer ,
content_filter_results:
{
Description: Content filtering results for this prompt ,
Required: True ,
}
{
sexual:
{
Description: Describes language related to anatomical organs and genitals, romantic relationships, acts portrayed in erotic or affectionate terms, physical sexual acts, including those portrayed as an assault or a forced sexual violent act against one’s will, prostitution, pornography, and abuse. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
violence:
{
Description: Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
hate:
{
Description: Describes language attacks or uses that include pejorative or discriminatory language with reference to a person or identity group on the basis of certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
self_harm:
{
Description: Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
profanity:
{
Description: Describes whether profanity was detected. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
}
,
custom_blocklists:
{
Description: Describes detection results against configured custom blocklists. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
details:
{
Description: The collection of detailed blocklist result information. ,
Required: True ,
}
[
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
id:
{
Description: The ID of the custom blocklist evaluated. ,
Required: True ,
}
string ,
}
,
]
,
}
,
error:
{
Description: Describes an error returned if the content filtering system is down or otherwise unable to complete the operation in time. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
jailbreak:
{
Description: Whether a jailbreak attempt was detected in the prompt. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
}
,
indirect_attack:
{
Description: Whether an indirect attack was detected in the prompt. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
]
,
choices:
{
Description: The collection of completions choices associated with this completions response. Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated. ,
Required: True ,
}
[
{
text:
{
Description: The generated text for a given completions prompt. ,
Required: True ,
}
string ,
index:
{
Description: The ordered index associated with this completions choice. ,
Format: int32 ,
Required: True ,
}
integer ,
content_filter_results:
{
Description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. ,
Required: False ,
}
{
sexual:
{
Description: Describes language related to anatomical organs and genitals, romantic relationships, acts portrayed in erotic or affectionate terms, physical sexual acts, including those portrayed as an assault or a forced sexual violent act against one’s will, prostitution, pornography, and abuse. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
violence:
{
Description: Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
hate:
{
Description: Describes language attacks or uses that include pejorative or discriminatory language with reference to a person or identity group on the basis of certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
self_harm:
{
Description: Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
profanity:
{
Description: Describes whether profanity was detected. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
}
,
custom_blocklists:
{
Description: Describes detection results against configured custom blocklists. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
details:
{
Description: The collection of detailed blocklist result information. ,
Required: True ,
}
[
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
id:
{
Description: The ID of the custom blocklist evaluated. ,
Required: True ,
}
string ,
}
,
]
,
}
,
error:
{
Description: Describes an error returned if the content filtering system is down or otherwise unable to complete the operation in time. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
protected_material_text:
{
Description: Information about detection of protected text material. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
}
,
protected_material_code:
{
Description: Information about detection of protected code material. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
URL:
{
Description: The internet location associated with the detection. ,
Format: uri ,
Required: False ,
}
string ,
license:
{
Description: The license description associated with the detection. ,
Required: False ,
}
string ,
}
,
ungrounded_material:
{
Description: Information about detection of ungrounded material. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
details:
{
Description: The collection of completion text spans. ,
Required: True ,
}
[
{
completion_start_offset:
{
Description: Offset of the UTF32 code point which begins the span. ,
Format: int32 ,
Required: True ,
}
integer ,
completion_end_offset:
{
Description: Offset of the first UTF32 code point which is excluded from the span. This field is always equal to completion_start_offset for empty spans. This field is always larger than completion_start_offset for non-empty spans. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
logprobs:
{
Description: The log probabilities model for tokens associated with this completions choice. ,
Required: True ,
}
object ,
finish_reason:
{
Description: Reason for finishing ,
Enum:
{
stop: Completions ended normally and reached its end of token generation. ,
length: Completions exhausted available token limits before generation could complete. ,
content_filter: Completions generated a response that was identified as potentially sensitive per content moderation policies. ,
function_call: Completion ended normally, with the model requesting a function to be called. ,
tool_calls: Completion ended with the model calling a provided tool for output. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
usage:
{
Description: Usage information for tokens processed and generated as part of this completions operation. ,
Required: True ,
}
{
completion_tokens:
{
Description: The number of tokens generated across all completions emissions. ,
Format: int32 ,
Required: True ,
}
integer ,
prompt_tokens:
{
Description: The number of tokens in the provided prompts for the completions request. ,
Format: int32 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: The total number of tokens processed for the completions request and response. ,
Format: int32 ,
Required: True ,
}
integer ,
prompt_tokens_details:
{
Description: Details of the prompt tokens. ,
Required: False ,
}
{
audio_tokens:
{
Description: Audio input tokens present in the prompt. ,
Format: int32 ,
Required: False ,
}
integer ,
cached_tokens:
{
Description: Cached tokens present in the prompt. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
completion_tokens_details:
{
Description: Breakdown of tokens used in a completion. ,
Required: False ,
}
{
accepted_prediction_tokens:
{
Description: When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion. ,
Format: int32 ,
Required: False ,
}
integer ,
audio_tokens:
{
Description: Audio input tokens generated by the model. ,
Format: int32 ,
Required: False ,
}
integer ,
reasoning_tokens:
{
Description: Tokens generated by the model for reasoning. ,
Format: int32 ,
Required: False ,
}
integer ,
rejected_prediction_tokens:
{
Description: When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
system_fingerprint:
{
Description: This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetEmbeddings (new)
Description :  Return the embeddings for a given prompt.
Reference :  Link ¶

⚼ Request

POST:  /deployments/{deploymentId}/embeddings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentId:
{
Description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. ,
Required: True ,
}
string ,
body:
{
Description: The configuration information for an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering, recommendations, and other similar scenarios. ,
Required: True ,
}
{
user:
{
Description: An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes. ,
Required: False ,
}
string ,
model:
{
Description: The model name to provide as part of this embeddings request. Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that's connected to. ,
Required: False ,
}
string ,
input:
{
Description: Input texts to get embeddings for, encoded as a an array of strings. Each input must not exceed 2048 tokens in length. Unless you are embedding code, we suggest replacing newlines (\n) in your input with a single space, as we have observed inferior results when newlines are present. ,
Required: True ,
}
[
string ,
]
,
encoding_format:
{
Description: The response encoding format to use for embedding data. ,
Enum:
{
float: Specifies that responses should provide arrays of floats for each embedding. ,
base64: Specifies that responses should provide a base64-encoded string for each embedding. ,
}
,
Required: False ,
}
enum ,
dimensions:
{
Description: The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models. ,
Format: int32 ,
Required: False ,
}
integer ,
input_type:
{
Description: When using Azure OpenAI, specifies the input type to use for embedding search. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
data:
{
Description: Embedding values for the prompts submitted in the request. ,
Required: True ,
}
[
{
embedding:
{
Description: List of embeddings value for the input prompt. These represent a measurement of the vector-based relatedness of the provided input. ,
Required: True ,
}
[
number ,
]
,
index:
{
Description: Index of the prompt to which the EmbeddingItem corresponds. ,
Format: int32 ,
Required: True ,
}
integer ,
object:
{
Description: The object type which is always 'embedding'. ,
Enum:
{
embedding: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
usage:
{
Description: Usage counts for tokens input using the embeddings API. ,
Required: True ,
}
{
prompt_tokens:
{
Description: Number of tokens sent in the original request. ,
Format: int32 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: Total number of tokens transacted in this request/response. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetImageGenerations (new)
Description :  Creates an image given a prompt.
Reference :  Link ¶

⚼ Request

POST:  /deployments/{deploymentId}/images/generations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentId:
{
Description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. ,
Required: True ,
}
string ,
body:
{
Description: Represents the request data used to generate images. ,
Required: True ,
}
{
model:
{
Description: The model name or Azure OpenAI model deployment name to use for image generation. If not specified, dall-e-2 will be inferred as a default. ,
Required: False ,
}
string ,
prompt:
{
Description: A description of the desired images. ,
Required: True ,
}
string ,
n:
{
Description: The number of images to generate. Dall-e-2 models support values between 1 and 10. Dall-e-3 models only support a value of 1. ,
Format: int32 ,
Required: False ,
}
integer ,
size:
{
Description: The desired dimensions for generated images. Dall-e-2 models support 256x256, 512x512, or 1024x1024. Dall-e-3 models support 1024x1024, 1792x1024, or 1024x1792. ,
Enum:
{
256x256: Very small image size of 256x256 pixels. Only supported with dall-e-2 models. ,
512x512: A smaller image size of 512x512 pixels. Only supported with dall-e-2 models. ,
1024x1024: A standard, square image size of 1024x1024 pixels. Supported by both dall-e-2 and dall-e-3 models. ,
1792x1024: A wider image size of 1024x1792 pixels. Only supported with dall-e-3 models. ,
1024x1792: A taller image size of 1792x1024 pixels. Only supported with dall-e-3 models. ,
}
,
Required: False ,
}
enum ,
response_format:
{
Description: The format in which image generation response items should be presented. ,
Enum:
{
url: Image generation response items should provide a URL from which the image may be retrieved. ,
b64_json: Image generation response items should provide image data as a base64-encoded string. ,
}
,
Required: False ,
}
enum ,
quality:
{
Description: The desired image generation quality level to use. Only configurable with dall-e-3 models. ,
Enum:
{
standard: Requests image generation with standard, balanced characteristics of quality, cost, and speed. ,
hd: Requests image generation with higher quality, higher cost and lower speed relative to standard. ,
}
,
Required: False ,
}
enum ,
style:
{
Description: The desired image generation style to use. Only configurable with dall-e-3 models. ,
Enum:
{
natural: Requests image generation in a natural style with less preference for dramatic and hyper-realistic characteristics. ,
vivid: Requests image generation in a vivid style with a higher preference for dramatic and hyper-realistic characteristics. ,
}
,
Required: False ,
}
enum ,
user:
{
Description: A unique identifier representing your end-user, which can help to monitor and detect abuse. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
created:
{
Description: A timestamp representing when this operation was started. Expressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000. ,
Format: unixtime ,
Required: True ,
}
integer ,
data:
{
Description: The images generated by the operation. ,
Required: True ,
}
[
{
url:
{
Description: The URL that provides temporary access to download the generated image. ,
Format: uri ,
Required: False ,
}
string ,
b64_json:
{
Description: The complete data for an image, represented as a base64-encoded string. ,
Required: False ,
}
string ,
content_filter_results:
{
Description: Information about the content filtering results. ,
Required: False ,
}
{
sexual:
{
Description: Describes language related to anatomical organs and genitals, romantic relationships, acts portrayed in erotic or affectionate terms, physical sexual acts, including those portrayed as an assault or a forced sexual violent act against one’s will, prostitution, pornography, and abuse. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
violence:
{
Description: Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
hate:
{
Description: Describes language attacks or uses that include pejorative or discriminatory language with reference to a person or identity group on the basis of certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
self_harm:
{
Description: Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
revised_prompt:
{
Description: The final prompt used by the model to generate the image. Only provided with dall-3-models and only when revisions were made to the prompt. ,
Required: False ,
}
string ,
prompt_filter_results:
{
Description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. ,
Required: False ,
}
{
sexual:
{
Description: Describes language related to anatomical organs and genitals, romantic relationships, acts portrayed in erotic or affectionate terms, physical sexual acts, including those portrayed as an assault or a forced sexual violent act against one’s will, prostitution, pornography, and abuse. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
violence:
{
Description: Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
hate:
{
Description: Describes language attacks or uses that include pejorative or discriminatory language with reference to a person or identity group on the basis of certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
self_harm:
{
Description: Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
severity:
{
Description: Ratings for the intensity and risk level of filtered content. ,
Enum:
{
safe: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences. ,
low: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity. ,
medium: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity. ,
high: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse. ,
}
,
Required: True ,
}
enum ,
}
,
profanity:
{
Description: Describes whether profanity was detected. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
}
,
jailbreak:
{
Description: Whether a jailbreak attempt was detected in the prompt. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
detected:
{
Description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. ,
Required: True ,
}
boolean ,
}
,
custom_blocklists:
{
Description: Information about customer block lists and if something was detected the associated list ID. ,
Required: False ,
}
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
details:
{
Description: The collection of detailed blocklist result information. ,
Required: True ,
}
[
{
filtered:
{
Description: A value indicating whether or not the content has been filtered. ,
Required: True ,
}
boolean ,
id:
{
Description: The ID of the custom blocklist evaluated. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListFiles (new)
Description :  Gets a list of previously uploaded files.
Reference :  Link ¶

⚼ Request

GET:  /files
{
purpose:
{
Description: A value that, when provided, limits list results to files matching the corresponding purpose. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always 'list'. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The files returned for the request. ,
Required: True ,
}
[
{
object:
{
Description: The object type, which is always 'file'. ,
Enum:
{
file: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
bytes:
{
Description: The size of the file, in bytes. ,
Format: int32 ,
Required: True ,
}
integer ,
filename:
{
Description: The name of the file. ,
Required: True ,
}
string ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
purpose:
{
Description: The intended purpose of a file. ,
Enum:
{
fine-tune: Indicates a file is used for fine tuning input. ,
fine-tune-results: Indicates a file is used for fine tuning results. ,
assistants: Indicates a file is used as input to assistants. ,
assistants_output: Indicates a file is used as output by assistants. ,
batch: Indicates a file is used as input to . ,
batch_output: Indicates a file is used as output by a vector store batch operation. ,
vision: Indicates a file is used as input to a vision operation. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The state of the file. This field is available in Azure OpenAI only. ,
Enum:
{
uploaded: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
processed: The operation has successfully processed and is ready for consumption. It can be categorized as a terminal state. ,
error: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
deleting: The entity is in the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. ,
deleted: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
status_details:
{
Description: The error message with details in case processing of this file failed. This field is available in Azure OpenAI only. ,
Required: False ,
}
string ,
}
,
]
,
}
UploadFile (new)
Description :  Uploads a file for use by other operations.
Reference :  Link ¶

⚼ Request

POST:  /files
{
file:
{
Description: The file data (not filename) to upload. ,
Required: True ,
}
file ,
purpose:
{
Description: The intended purpose of the file. ,
Required: True ,
}
string ,
filename:
{
Description: A filename to associate with the uploaded data. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always 'file'. ,
Enum:
{
file: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
bytes:
{
Description: The size of the file, in bytes. ,
Format: int32 ,
Required: True ,
}
integer ,
filename:
{
Description: The name of the file. ,
Required: True ,
}
string ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
purpose:
{
Description: The intended purpose of a file. ,
Enum:
{
fine-tune: Indicates a file is used for fine tuning input. ,
fine-tune-results: Indicates a file is used for fine tuning results. ,
assistants: Indicates a file is used as input to assistants. ,
assistants_output: Indicates a file is used as output by assistants. ,
batch: Indicates a file is used as input to . ,
batch_output: Indicates a file is used as output by a vector store batch operation. ,
vision: Indicates a file is used as input to a vision operation. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The state of the file. This field is available in Azure OpenAI only. ,
Enum:
{
uploaded: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
processed: The operation has successfully processed and is ready for consumption. It can be categorized as a terminal state. ,
error: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
deleting: The entity is in the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. ,
deleted: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
status_details:
{
Description: The error message with details in case processing of this file failed. This field is available in Azure OpenAI only. ,
Required: False ,
}
string ,
}
GetFile (new)
Description :  Returns information about a specific file. Does not retrieve file content.
Reference :  Link ¶

⚼ Request

GET:  /files/{fileId}
{
fileId:
{
Description: The ID of the file to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always 'file'. ,
Enum:
{
file: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
bytes:
{
Description: The size of the file, in bytes. ,
Format: int32 ,
Required: True ,
}
integer ,
filename:
{
Description: The name of the file. ,
Required: True ,
}
string ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
purpose:
{
Description: The intended purpose of a file. ,
Enum:
{
fine-tune: Indicates a file is used for fine tuning input. ,
fine-tune-results: Indicates a file is used for fine tuning results. ,
assistants: Indicates a file is used as input to assistants. ,
assistants_output: Indicates a file is used as output by assistants. ,
batch: Indicates a file is used as input to . ,
batch_output: Indicates a file is used as output by a vector store batch operation. ,
vision: Indicates a file is used as input to a vision operation. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The state of the file. This field is available in Azure OpenAI only. ,
Enum:
{
uploaded: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
processed: The operation has successfully processed and is ready for consumption. It can be categorized as a terminal state. ,
error: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
deleting: The entity is in the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. ,
deleted: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
status_details:
{
Description: The error message with details in case processing of this file failed. This field is available in Azure OpenAI only. ,
Required: False ,
}
string ,
}
DeleteFile (new)
Description :  Delete a previously uploaded file.
Reference :  Link ¶

⚼ Request

DELETE:  /files/{fileId}
{
fileId:
{
Description: The ID of the file to delete. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource specified for deletion. ,
Required: True ,
}
string ,
deleted:
{
Description: A value indicating whether deletion was successful. ,
Required: True ,
}
boolean ,
object:
{
Description: The object type, which is always 'file'. ,
Enum:
{
file: No description available. ,
}
,
Required: True ,
}
enum ,
}
GetFileContent (new)
Description :  Returns information about a specific file. Does not retrieve file content.
Reference :  Link ¶

⚼ Request

GET:  /files/{fileId}/content
{
fileId:
{
Description: The ID of the file to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Format: byte ,
}
string ,
}
CreateUpload (new)
Description :  Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it. Once you complete the Upload, we will create a File object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object. For certain purposes, the correct mime_type must be specified. Please refer to documentation for the supported MIME types for your use case. For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File.
Reference :  Link ¶

⚼ Request

POST:  /uploads
{
requestBody:
{
Description: The request body for the operation options. ,
Required: True ,
}
{
filename:
{
Description: The name of the file to upload. ,
Required: True ,
}
string ,
purpose:
{
Description: The intended purpose of the uploaded file. Use 'assistants' for Assistants and Message files, 'vision' for Assistants image file inputs, 'batch' for Batch API, and 'fine-tune' for Fine-tuning. ,
Enum:
{
assistants: No description available. ,
batch: No description available. ,
fine-tune: No description available. ,
vision: No description available. ,
}
,
Required: True ,
}
enum ,
bytes:
{
Description: The number of bytes in the file you are uploading. ,
Format: int32 ,
Required: True ,
}
integer ,
mime_type:
{
Description: The MIME type of the file. This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The Upload unique identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the Upload was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
filename:
{
Description: The name of the file to be uploaded. ,
Required: True ,
}
string ,
bytes:
{
Description: The intended number of bytes to be uploaded. ,
Format: int64 ,
Required: True ,
}
integer ,
purpose:
{
Description: The intended purpose of the file. ,
Enum:
{
batch: No description available. ,
batch_output: No description available. ,
fine-tune: No description available. ,
fine-tune-results: No description available. ,
assistants: No description available. ,
assistants_output: No description available. ,
vision: No description available. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the Upload. ,
Enum:
{
pending: No description available. ,
completed: No description available. ,
cancelled: No description available. ,
expired: No description available. ,
}
,
Required: True ,
}
enum ,
expires_at:
{
Description: The Unix timestamp (in seconds) for when the Upload was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
object:
{
Description: The object type, which is always "upload". ,
Enum:
{
upload: No description available. ,
}
,
Required: False ,
}
enum ,
file:
{
Description: The ready File object after the Upload is completed. ,
Required: False ,
}
object ,
}
CancelUpload (new)
Description :  Cancels the Upload. No Parts may be added after an Upload is cancelled.
Reference :  Link ¶

⚼ Request

POST:  /uploads/{upload_id}/cancel
{
upload_id:
{
Description: The ID of the upload associated with this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The Upload unique identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the Upload was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
filename:
{
Description: The name of the file to be uploaded. ,
Required: True ,
}
string ,
bytes:
{
Description: The intended number of bytes to be uploaded. ,
Format: int64 ,
Required: True ,
}
integer ,
purpose:
{
Description: The intended purpose of the file. ,
Enum:
{
batch: No description available. ,
batch_output: No description available. ,
fine-tune: No description available. ,
fine-tune-results: No description available. ,
assistants: No description available. ,
assistants_output: No description available. ,
vision: No description available. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the Upload. ,
Enum:
{
pending: No description available. ,
completed: No description available. ,
cancelled: No description available. ,
expired: No description available. ,
}
,
Required: True ,
}
enum ,
expires_at:
{
Description: The Unix timestamp (in seconds) for when the Upload was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
object:
{
Description: The object type, which is always "upload". ,
Enum:
{
upload: No description available. ,
}
,
Required: False ,
}
enum ,
file:
{
Description: The ready File object after the Upload is completed. ,
Required: False ,
}
object ,
}
CompleteUpload (new)
Description :  Completes the Upload. Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform. You can specify the order of the Parts by passing in an ordered list of the Part IDs. The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
Reference :  Link ¶

⚼ Request

POST:  /uploads/{upload_id}/complete
{
upload_id:
{
Description: The ID of the upload associated with this operation. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body for the completion operation. ,
Required: True ,
}
{
part_ids:
{
Description: The ordered list of Part IDs. ,
Required: True ,
}
[
string ,
]
,
md5:
{
Description: The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The Upload unique identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the Upload was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
filename:
{
Description: The name of the file to be uploaded. ,
Required: True ,
}
string ,
bytes:
{
Description: The intended number of bytes to be uploaded. ,
Format: int64 ,
Required: True ,
}
integer ,
purpose:
{
Description: The intended purpose of the file. ,
Enum:
{
batch: No description available. ,
batch_output: No description available. ,
fine-tune: No description available. ,
fine-tune-results: No description available. ,
assistants: No description available. ,
assistants_output: No description available. ,
vision: No description available. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the Upload. ,
Enum:
{
pending: No description available. ,
completed: No description available. ,
cancelled: No description available. ,
expired: No description available. ,
}
,
Required: True ,
}
enum ,
expires_at:
{
Description: The Unix timestamp (in seconds) for when the Upload was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
object:
{
Description: The object type, which is always "upload". ,
Enum:
{
upload: No description available. ,
}
,
Required: False ,
}
enum ,
file:
{
Description: The ready File object after the Upload is completed. ,
Required: False ,
}
object ,
}
AddUploadPart (new)
Description :  Adds a Part to an Upload object. A Part represents a chunk of bytes from the file you are trying to upload. Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB. It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you complete the Upload.
Reference :  Link ¶

⚼ Request

POST:  /uploads/{upload_id}/parts
{
upload_id:
{
Description: The ID of the upload associated with this operation. ,
Required: True ,
}
string ,
data:
{
Description: The chunk of bytes for this Part. ,
Required: True ,
}
file ,
}

⚐ Response (200)

{
id:
{
Description: The upload Part unique identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the Part was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
upload_id:
{
Description: The ID of the Upload object that this Part was added to. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `upload.part`. ,
Enum:
{
upload.part: No description available. ,
}
,
Required: True ,
}
enum ,
azure_block_id:
{
Description: Azure only field. ,
Required: False ,
}
string ,
}